Skip to content

Conversation

@clatapie
Copy link
Contributor

Closes #43.

@clatapie clatapie linked an issue Feb 16, 2024 that may be closed by this pull request
@PipKat
Copy link
Member

PipKat commented Feb 16, 2024

@clatapie I've finished reviewing the existing doc content. The biggest change was to redo the README in our new format and consolidate user installation info in the "Getting started" section and developer installation info in the "Contribute" section. I would like to quickly review whatever content is added soon for the "User guide" section.

@clatapie
Copy link
Contributor Author

clatapie commented Feb 19, 2024

Thank you @PipKat for your time and for your prompt feedback on the documentation!
Regarding the User guide section, I am pinging the @ansys/modelcenter-team for visibility.

RobPasMue
RobPasMue previously approved these changes Feb 20, 2024
@clatapie
Copy link
Contributor Author

clatapie commented Feb 20, 2024

To do before merging:

  • removing the TODO list in the README.rst file after having checked each task
  • completing the User Guide section

Co-authored-by: Roberto Pastor Muela <37798125+RobPasMue@users.noreply.github.com>
RobPasMue
RobPasMue previously approved these changes Feb 21, 2024
@clatapie clatapie requested a review from PipKat February 21, 2024 09:20
Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com>
Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com>
@clatapie clatapie requested a review from PipKat February 22, 2024 17:17
Copy link
Member

@PipKat PipKat left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Thanks, @clatapie.

@RobPasMue RobPasMue merged commit 18ba21d into main Feb 23, 2024
@RobPasMue RobPasMue deleted the maint/doc_review branch February 23, 2024 07:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

maint: documentation review

5 participants